Skip to content
index.html 27 KiB
Newer Older

<!doctype html>
<html lang="en" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      
        <meta name="description" content="ETSI SDG TFS Documentation page">
      
      
        <meta name="author" content="TeraflowSDN by ETSI">
      
      
        <link rel="canonical" href="https://tfs.etsi.org/develop/testing/testplan/api_auditing_service/">
      
      
      
      
      <link rel="icon" href="../../../images/favicon.png">
      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
    
    
      
        <title>Test Plan for CAPIF Api Auditing Service - ETSI SDG TFS Documentation</title>
      
    
    
      <link rel="stylesheet" href="../../../assets/stylesheets/main.0253249f.min.css">
      
        
        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
      
      


    
    
      
    
    
      
        
        
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
      
    
    
      <link rel="stylesheet" href="../../../stylesheets/extra.css">
    
    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
    
      

    
    
    
  </head>
  
  
    
    
    
    
    
    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="0D47A1" data-md-color-accent="1565C0">
  
    
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">
      
        
        <a href="#test-plan-for-capif-api-auditing-service" class="md-skip">
          Skip to content
        </a>
      
    </div>
    <div data-md-component="announce">
      
    </div>
    
      <div data-md-color-scheme="default" data-md-component="outdated" hidden>
        
      </div>
    
    
      

  

<header class="md-header md-header--shadow" data-md-component="header">
  <nav class="md-header__inner md-grid" aria-label="Header">
    <a href="../../.." title="ETSI SDG TFS Documentation" class="md-header__button md-logo" aria-label="ETSI SDG TFS Documentation" data-md-component="logo">
      
  <img src="../../../images/logos/TeraFlow SDN Logo Screen_B_W NEG.png" alt="logo">

    </a>
    <label class="md-header__button md-icon" for="__drawer">
      
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
    </label>
    <div class="md-header__title" data-md-component="header-title">
      <div class="md-header__ellipsis">
        <div class="md-header__topic">
          <span class="md-ellipsis">
            ETSI SDG TFS Documentation
          </span>
        </div>
        <div class="md-header__topic" data-md-component="header-topic">
          <span class="md-ellipsis">
            
              Test Plan for CAPIF Api Auditing Service
            
          </span>
        </div>
      </div>
    </div>
    
      
    
    
    
    
      <label class="md-header__button md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
      </label>
      <div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
      <label class="md-search__icon md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
      </label>
      <nav class="md-search__options" aria-label="Search">
        
        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
          
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
        </button>
      </nav>
      
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            Initializing search
          </div>
          <ol class="md-search-result__list" role="presentation"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
    
    
      <div class="md-header__source">
        <a href="https://labs.etsi.org/rep/tfs" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="m503.5 204.6-.7-1.8-69.7-181.78c-1.4-3.57-3.9-6.59-7.2-8.64-2.4-1.55-5.1-2.515-8-2.81s-5.7.083-8.4 1.11c-2.7 1.02-5.1 2.66-7.1 4.78-1.9 2.12-3.3 4.67-4.1 7.44l-47 144H160.8l-47.1-144c-.8-2.77-2.2-5.31-4.1-7.43-2-2.12-4.4-3.75-7.1-4.77a18.1 18.1 0 0 0-8.38-1.113 18.4 18.4 0 0 0-8.04 2.793 18.1 18.1 0 0 0-7.16 8.64L9.267 202.8l-.724 1.8a129.57 129.57 0 0 0-3.52 82c7.747 26.9 24.047 50.7 46.447 67.6l.27.2.59.4 105.97 79.5 52.6 39.7 32 24.2c3.7 1.9 8.3 4.3 13 4.3s9.3-2.4 13-4.3l32-24.2 52.6-39.7 106.7-79.9.3-.3c22.4-16.9 38.7-40.6 45.6-67.5 8.6-27 7.4-55.8-2.6-82"/></svg>
  </div>
  <div class="md-source__repository">
    TFS GitLab
  </div>
</a>
      </div>
    
  </nav>
  
</header>
    
    <div class="md-container" data-md-component="container">
      
      
        
          
        
      
      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">
          
            
              
              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    


<nav class="md-nav md-nav--primary md-nav--integrated" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href="../../.." title="ETSI SDG TFS Documentation" class="md-nav__button md-logo" aria-label="ETSI SDG TFS Documentation" data-md-component="logo">
      
  <img src="../../../images/logos/TeraFlow SDN Logo Screen_B_W NEG.png" alt="logo">

    </a>
    ETSI SDG TFS Documentation
  </label>
  
    <div class="md-nav__source">
      <a href="https://labs.etsi.org/rep/tfs" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="m503.5 204.6-.7-1.8-69.7-181.78c-1.4-3.57-3.9-6.59-7.2-8.64-2.4-1.55-5.1-2.515-8-2.81s-5.7.083-8.4 1.11c-2.7 1.02-5.1 2.66-7.1 4.78-1.9 2.12-3.3 4.67-4.1 7.44l-47 144H160.8l-47.1-144c-.8-2.77-2.2-5.31-4.1-7.43-2-2.12-4.4-3.75-7.1-4.77a18.1 18.1 0 0 0-8.38-1.113 18.4 18.4 0 0 0-8.04 2.793 18.1 18.1 0 0 0-7.16 8.64L9.267 202.8l-.724 1.8a129.57 129.57 0 0 0-3.52 82c7.747 26.9 24.047 50.7 46.447 67.6l.27.2.59.4 105.97 79.5 52.6 39.7 32 24.2c3.7 1.9 8.3 4.3 13 4.3s9.3-2.4 13-4.3l32-24.2 52.6-39.7 106.7-79.9.3-.3c22.4-16.9 38.7-40.6 45.6-67.5 8.6-27 7.4-55.8-2.6-82"/></svg>
  </div>
  <div class="md-source__repository">
    TFS GitLab
  </div>
</a>
    </div>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../../.." class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Index
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../../../deployment_guide/deployment_guide/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
      <a href="../../../development_guide/development_guide/" class="md-nav__link">
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
    
  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
          
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  


<h1 id="test-plan-for-capif-api-auditing-service">Test Plan for CAPIF Api Auditing Service</h1>
<p>At this documentation you will have all information and related files and examples of test plan for this API.</p>
<h2 id="test-case-1-get-capif-log-entry">Test Case 1: Get CAPIF Log Entry.</h2>
<p><strong>Test ID</strong>: <strong><em>capif_api_auditing-1</em></strong></p>
<p><strong>Description</strong>:</p>
<p>This test case will check that a CAPIF AMF can get log entry to Logging Service</p>
<p><strong>Pre-Conditions</strong>:</p>
<ul>
<li>CAPIF provider is pre-authorised (has valid AMF cert from CAPIF Authority)</li>
<li>Service exist in CAPIF</li>
<li>Invoker exist in CAPIF</li>
<li>Log Entry exist in CAPIF</li>
</ul>
<p><strong>Execution Steps</strong>:
  1. Register Provider and Invoker CCF
  2. Publish Service
  3. Create Log Entry
  4. Get Log Entry</p>
<p><strong>Information of Test</strong>:</p>
<ol>
<li>
<p>Perform <a href="../common_operations/#register-a-provider" title="Provider Onboarding">provider onboarding</a>, <a href="../common_operations/#onboard-an-invoker" title="Invoker Onboarding">invoker onboarding</a> </p>
</li>
<li>
<p>Publish Service API at CCF:</p>
<ul>
<li>Send <strong>POST</strong> to ccf_publish_url <strong>https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis</strong></li>
<li>body [service api description] with apiName <strong>service_1</strong></li>
<li>Use <strong>APF Certificate</strong></li>
</ul>
</li>
<li>
<p>Create Log Entry:</p>
<ul>
<li>Send <strong>POST</strong> to <strong>https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs</strong></li>
<li>body <a href="../api_logging_service/invocation_log.json" title="Log Request Body">log entry request body</a></li>
<li>Use <strong>AEF Certificate</strong></li>
</ul>
</li>
<li>
<p>Get Log:</p>
<ol>
<li>Send <strong>GET</strong> to <strong>https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs?aef-id={aefId}&amp;api-invoker-id={api-invoker-id}</strong></li>
<li>Use <strong>AMF Certificate</strong></li>
</ol>
</li>
</ol>
<p><strong>Expected Result</strong>:</p>
<ol>
<li>Response to Logging Service must accomplish:<ol>
<li><strong>200 OK</strong></li>
<li>Response Body must follow <strong>InvocationLog</strong> data structure with:<ul>
<li>aefId</li>
<li>apiInvokerId</li>
<li>logs</li>
</ul>
</li>
</ol>
</li>
</ol>
<h2 id="test-case-2-get-capif-log-entry-with-no-log-entry-in-capif">Test Case 2: Get CAPIF Log Entry With no Log entry in CAPIF.</h2>
<p><strong>Test ID</strong>: <strong><em>capif_api_auditing-2</em></strong></p>
<p><strong>Description</strong>:</p>
<p>This test case will check that a CAPIF AEF can create log entry to Logging Service</p>
<p><strong>Pre-Conditions</strong>:</p>
<ul>
<li>CAPIF provider is pre-authorised (has valid AMF cert from CAPIF Authority)</li>
<li>Service exist in CAPIF</li>
<li>Invoker exist in CAPIF</li>
</ul>
<p><strong>Execution Steps</strong>:
  1. Register Provider and Invoker CCF
  2. Publish Service
  3. Get Log Entry</p>
<p><strong>Information of Test</strong>:</p>
<ol>
<li>
<p>Perform <a href="../common_operations/#register-a-provider" title="Provider Onboarding">provider onboarding</a>, <a href="../common_operations/#onboard-an-invoker" title="Invoker Onboarding">invoker onboarding</a> </p>
</li>
<li>
<p>Publish Service API at CCF:</p>
<ul>
<li>Send <strong>POST</strong> to ccf_publish_url <strong>https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis</strong></li>
<li>body [service api description] with apiName <strong>service_1</strong></li>
<li>Use <strong>APF Certificate</strong></li>
</ul>
</li>
<li>
<p>Get Log:</p>
<ol>
<li>Send <strong>GET</strong> to <strong>https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs?aef-id={aefId}&amp;api-invoker-id={api-invoker-id}</strong></li>
<li>Use <strong>AMF Certificate</strong></li>
</ol>
</li>
</ol>
<p><strong>Expected Result</strong>:</p>
<ol>
<li>Response to Logging Service must accomplish:<ol>
<li><strong>404 Not Found</strong></li>
<li>Error Response Body must accomplish with <strong>ProblemDetails</strong> data structure with:<ul>
<li>status 404</li>
<li>title with message "Not Found Log Entry in CAPIF".</li>
<li>cause with message "Not Exist Logs with the filters applied".</li>
</ul>
</li>
</ol>
</li>
</ol>
<h2 id="test-case-3-get-capif-log-entry-without-aef-id-and-api-invoker-id">Test Case 3: Get CAPIF Log Entry without aef-id and api-invoker-id.</h2>
<p><strong>Test ID</strong>: <strong><em>capif_api_auditing-3</em></strong></p>
<p><strong>Description</strong>:</p>
<p>This test case will check that a CAPIF AEF can create log entry to Logging Service</p>
<p><strong>Pre-Conditions</strong>:</p>
<ul>
<li>CAPIF provider is no pre-authorised (has no valid AMF cert from CAPIF Authority)</li>
<li>Service exist in CAPIF</li>
<li>Invoker exist in CAPIF</li>
<li>Log Entry exist in CAPIF</li>
</ul>
<p><strong>Execution Steps</strong>:
  1. Register Provider and Invoker CCF
  2. Publish Service
  3. Create Log Entry
  4. Get Log Entry</p>
<p><strong>Information of Test</strong>:</p>
<ol>
<li>
<p>Perform <a href="../common_operations/#register-a-provider" title="Provider Onboarding">provider onboarding</a>, <a href="../common_operations/#onboard-an-invoker" title="Invoker Onboarding">invoker onboarding</a> </p>
</li>
<li>
<p>Publish Service API at CCF:</p>
<ul>
<li>Send <strong>POST</strong> to ccf_publish_url <strong>https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis</strong></li>
<li>body [service api description] with apiName <strong>service_1</strong></li>
<li>Use <strong>APF Certificate</strong></li>
</ul>
</li>
<li>
<p>Create Log Entry:</p>
<ul>
<li>Send <strong>POST</strong> to <strong>https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs</strong></li>
<li>body <a href="../api_logging_service/invocation_log.json" title="Log Request Body">log entry request body</a></li>
<li>Use <strong>AEF Certificate</strong></li>
</ul>
</li>
<li>
<p>Get Log:</p>
<ol>
<li>Send <strong>GET</strong> to <strong>https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs</strong></li>
<li>Use <strong>AMF Certificate</strong></li>
</ol>
</li>
</ol>
<p><strong>Expected Result</strong>:</p>
<ol>
<li>Response to Logging Service must accomplish:<ol>
<li><strong>400 Bad Request</strong></li>
<li>Error Response Body must accomplish with <strong>ProblemDetails</strong> data structure with:<ul>
<li>status 400</li>
<li>title with message "Bad Request"</li>
<li>detail with message "aef_id and api_invoker_id parameters are mandatory".</li>
<li>cause with message "Mandatory parameters missing".</li>
</ul>
</li>
</ol>
</li>
</ol>
<h2 id="test-case-4-get-capif-log-entry-with-filtter-api-version">Test Case 4: Get CAPIF Log Entry with filtter api-version.</h2>
<p><strong>Test ID</strong>: <strong><em>capif_api_auditing-4</em></strong></p>
<p><strong>Description</strong>:</p>
<p>This test case will check that a CAPIF AMF can get log entry to Logging Service</p>
<p><strong>Pre-Conditions</strong>:</p>
<ul>
<li>CAPIF provider is pre-authorised (has valid AMF cert from CAPIF Authority)</li>
<li>Service exist in CAPIF</li>
<li>Invoker exist in CAPIF</li>
<li>Log Entry exist in CAPIF</li>
</ul>
<p><strong>Execution Steps</strong>:
  1. Register Provider and Invoker CCF
  2. Publish Service
  3. Create Log Entry
  4. Get Log Entry</p>
<p><strong>Information of Test</strong>:</p>
<ol>
<li>
<p>Perform <a href="../common_operations/#register-a-provider" title="Provider Onboarding">provider onboarding</a>, <a href="../common_operations/#onboard-an-invoker" title="Invoker Onboarding">invoker onboarding</a> </p>
</li>
<li>
<p>Publish Service API at CCF:</p>
<ul>
<li>Send <strong>POST</strong> to ccf_publish_url <strong>https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis</strong></li>
<li>body [service api description] with apiName <strong>service_1</strong></li>
<li>Use <strong>APF Certificate</strong></li>
</ul>
</li>
<li>
<p>Create Log Entry:</p>
<ul>
<li>Send <strong>POST</strong> to <strong>https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs</strong></li>
<li>body <a href="../api_logging_service/invocation_log.json" title="Log Request Body">log entry request body</a></li>
<li>Use <strong>AEF Certificate</strong></li>
</ul>
</li>
<li>
<p>Get Log:</p>
<ol>
<li>Send <strong>GET</strong> to <strong>https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs?aef-id={aefId}&amp;api-invoker-id={api-invoker-id}&amp;api-version={v1}</strong></li>
<li>Use <strong>AMF Certificate</strong></li>
</ol>
</li>
</ol>
<p><strong>Expected Result</strong>:</p>
<ol>
<li>Response to Logging Service must accomplish:<ol>
<li><strong>200 OK</strong></li>
<li>Response Body must follow <strong>InvocationLog</strong> data structure with:<ul>
<li>aefId</li>
<li>apiInvokerId</li>
<li>logs</li>
</ul>
</li>
</ol>
</li>
</ol>
<h2 id="test-case-5-get-capif-log-entry-with-filter-api-version-but-not-exist-in-log-entry">Test Case 5: Get CAPIF Log Entry with filter api-version but not exist in log entry.</h2>
<p><strong>Test ID</strong>: <strong><em>capif_api_auditing-4</em></strong></p>
<p><strong>Description</strong>:</p>
<p>This test case will check that a CAPIF AMF can get log entry to Logging Service</p>
<p><strong>Pre-Conditions</strong>:</p>
<ul>
<li>CAPIF provider is pre-authorised (has valid AMF cert from CAPIF Authority)</li>
<li>Service exist in CAPIF</li>
<li>Invoker exist in CAPIF</li>
<li>Log Entry exist in CAPIF</li>
</ul>
<p><strong>Execution Steps</strong>:
  1. Register Provider and Invoker CCF
  2. Publish Service
  3. Create Log Entry
  4. Get Log Entry</p>
<p><strong>Information of Test</strong>:</p>
<ol>
<li>
<p>Perform <a href="../common_operations/#register-a-provider" title="Provider Onboarding">provider onboarding</a>, <a href="../common_operations/#onboard-an-invoker" title="Invoker Onboarding">invoker onboarding</a> </p>
</li>
<li>
<p>Publish Service API at CCF:</p>
<ul>
<li>Send <strong>POST</strong> to ccf_publish_url <strong>https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis</strong></li>
<li>body [service api description] with apiName <strong>service_1</strong></li>
<li>Use <strong>APF Certificate</strong></li>
</ul>
</li>
<li>
<p>Create Log Entry:</p>
<ul>
<li>Send <strong>POST</strong> to <strong>https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs</strong></li>
<li>body <a href="../api_logging_service/invocation_log.json" title="Log Request Body">log entry request body</a></li>
<li>Use <strong>AEF Certificate</strong></li>
</ul>
</li>
<li>
<p>Get Log:</p>
<ol>
<li>Send <strong>GET</strong> to <strong>https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs?aef-id={aefId}&amp;api-invoker-id={api-invoker-id}&amp;api-version={v58}</strong></li>
<li>Use <strong>AMF Certificate</strong></li>
</ol>
</li>
</ol>
<p><strong>Expected Result</strong>:</p>
<ol>
<li>Response to Logging Service must accomplish:<ol>
<li><strong>404 Not Found</strong></li>
<li>Error Response Body must accomplish with <strong>ProblemDetails</strong> data structure with:<ul>
<li>status 404</li>
<li>detail with message "Parameters do not match any log entry"</li>
<li>cause with message "No logs found".</li>
</ul>
</li>
</ol>
</li>
</ol>












                
              </article>
            </div>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>
        
          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
  Back to top
</button>
        
      </main>
      
        <footer class="md-footer">
  
    
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-copyright">
  
    <div class="md-copyright__highlight">
      Copyright &copy; 2019-2024 TeraflowSDN Project
    </div>
  
  
    Made with
    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
      Material for MkDocs
    </a>
  
</div>
      
        <div class="md-social">
  
    
    
    
    
      
      
    
    <a href="https://tfs.etsi.org/" target="_blank" rel="noopener" title="tfs.etsi.org" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M352 256c0 22.2-1.2 43.6-3.3 64H163.4c-2.2-20.4-3.3-41.8-3.3-64s1.2-43.6 3.3-64h185.3c2.2 20.4 3.3 41.8 3.3 64m28.8-64h123.1c5.3 20.5 8.1 41.9 8.1 64s-2.8 43.5-8.1 64H380.8c2.1-20.6 3.2-42 3.2-64s-1.1-43.4-3.2-64m112.6-32H376.7c-10-63.9-29.8-117.4-55.3-151.6 78.3 20.7 142 77.5 171.9 151.6zm-149.1 0H167.7c6.1-36.4 15.5-68.6 27-94.7 10.5-23.6 22.2-40.7 33.5-51.5C239.4 3.2 248.7 0 256 0s16.6 3.2 27.8 13.8c11.3 10.8 23 27.9 33.5 51.5 11.6 26 20.9 58.2 27 94.7m-209 0H18.6c30-74.1 93.6-130.9 172-151.6-25.5 34.2-45.3 87.7-55.3 151.6M8.1 192h123.1c-2.1 20.6-3.2 42-3.2 64s1.1 43.4 3.2 64H8.1C2.8 299.5 0 278.1 0 256s2.8-43.5 8.1-64m186.6 254.6c-11.6-26-20.9-58.2-27-94.6h176.6c-6.1 36.4-15.5 68.6-27 94.6-10.5 23.6-22.2 40.7-33.5 51.5-11.2 10.7-20.5 13.9-27.8 13.9s-16.6-3.2-27.8-13.8c-11.3-10.8-23-27.9-33.5-51.5zM135.3 352c10 63.9 29.8 117.4 55.3 151.6-78.4-20.7-142-77.5-172-151.6zm358.1 0c-30 74.1-93.6 130.9-171.9 151.6 25.5-34.2 45.2-87.7 55.3-151.6h116.7z"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://labs.etsi.org/rep/tfs" target="_blank" rel="noopener" title="labs.etsi.org" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="m503.5 204.6-.7-1.8-69.7-181.78c-1.4-3.57-3.9-6.59-7.2-8.64-2.4-1.55-5.1-2.515-8-2.81s-5.7.083-8.4 1.11c-2.7 1.02-5.1 2.66-7.1 4.78-1.9 2.12-3.3 4.67-4.1 7.44l-47 144H160.8l-47.1-144c-.8-2.77-2.2-5.31-4.1-7.43-2-2.12-4.4-3.75-7.1-4.77a18.1 18.1 0 0 0-8.38-1.113 18.4 18.4 0 0 0-8.04 2.793 18.1 18.1 0 0 0-7.16 8.64L9.267 202.8l-.724 1.8a129.57 129.57 0 0 0-3.52 82c7.747 26.9 24.047 50.7 46.447 67.6l.27.2.59.4 105.97 79.5 52.6 39.7 32 24.2c3.7 1.9 8.3 4.3 13 4.3s9.3-2.4 13-4.3l32-24.2 52.6-39.7 106.7-79.9.3-.3c22.4-16.9 38.7-40.6 45.6-67.5 8.6-27 7.4-55.8-2.6-82"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://www.linkedin.com/company/teraflowsdn/" target="_blank" rel="noopener" title="www.linkedin.com" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3M135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5m282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9z"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://twitter.com/TeraflowSDN" target="_blank" rel="noopener" title="twitter.com" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M389.2 48h70.6L305.6 224.2 487 464H345L233.7 318.6 106.5 464H35.8l164.9-188.5L26.8 48h145.6l100.5 132.9zm-24.8 373.8h39.1L151.1 88h-42z"/></svg>
    </a>
  
</div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
    
    
    <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight", "toc.integrate"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
      <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>