Releases/1.7.0 (#5)

APNF · Sep 9, 2024 · cb720e0 · cb720e0
1 parent 8be1502
commit cb720e0
Show file tree

Hide file tree

Showing 6 changed files with 11,389 additions and 4,813 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.7.0 - 2024/09/09
+
+- (Plateform) New Open API file for APNF MAN Platform - Platform API Reference
+- (GCO) (Certificates) Add `INVALIDATION` status to be used during CA compromission
+- (GCO) (Certificates) New API method - GET /certificates/export
+- (GCO) (Providers) Cleanup provider unused examples and schemas
+- (GCO) (Providers) Remove users and history API methods as available as part of the **MAN Platform API Reference** document.
+
+
 ## 1.6.0 - 2023/12/13
 
 - (BPCO) (Description) Fix spelling error in 'Rate limiting'

diff --git a/README.md b/README.md
@@ -15,6 +15,15 @@ If you are a service provider operating in France, you need to be registered as
 If you are not yet a member, please contact the APNF.
 
 
+## MAN Platform API
+> [apnf-man-platform-openapi.yaml](apnf-man-platform-openapi.yaml) / (View in [Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/apnf/man-openapi/main/apnf-man-platform-openapi.yaml))
+
+MAN platform APIs to create and manage users, credentials, STI certificates and
+all other objects that service providers can handle on the MAN platform.
+
+More information is available in the OpenAPI file itself.
+
+
 ## Authentication API
 > [apnf-man-platform-openapi-auth.yaml](apnf-man-platform-openapi-auth.yaml) / (View in [Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/apnf/man-openapi/main/apnf-man-platform-openapi-auth.yaml))
 
@@ -26,10 +35,11 @@ More information is available in the OpenAPI file itself.
 ## GCO API
 > [apnf-man-platform-openapi-gco.yaml](apnf-man-platform-openapi-gco.yaml) / (View in [Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/apnf/man-openapi/main/apnf-man-platform-openapi-gco.yaml))
 
-This API reference explains how to get access to all MAN platform functionalities, especially the creation and management of STI certificates to be used by service providers for signing their SIP telephone calls per the STIR SHAKEN protocol.
+This API reference explains how to get access to MAN platform functionalities related to the creation and management of STI certificates to be used by service providers for signing their SIP telephone calls per the STIR SHAKEN protocol.
 
-More information is available in the OpenAPI file itself.
+This API is a subset of the [MAN Platform API](apnf-man-platform-openapi.yaml)
 
+More information is available in the OpenAPI file itself.
 
 ## BPCO API
 > [apnf-man-platform-openapi-bpco.yaml](apnf-man-platform-openapi-bpco.yaml) / (View in [Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/apnf/man-openapi/main/apnf-man-platform-openapi-bpco.yaml))

diff --git a/apnf-man-platform-openapi-auth.yaml b/apnf-man-platform-openapi-auth.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: APNF MAN Platform - API Authentication Reference
-  version: 1.6.0
+  version: 1.7.0
   license:
     name: CC-BY-SA-4.0
     url: https://creativecommons.org/licenses/by-sa/4.0/legalcode
@@ -44,6 +44,10 @@ info:
     - **MAN Platform BPCO API Reference**, listing APIs published as part of the BPCO (Base Publique des Certificats Opérateurs), the MAN platform public access service used to access STI certificates.
 
     # History
+    **1.7.0** - 2024/09/09
+    - Reorder alphabetically components
+
+    **1.6.0** - N/A
 
     **1.5.0** - 2023/09/27
     - Clarify access token lifetime

diff --git a/apnf-man-platform-openapi-bpco.yaml b/apnf-man-platform-openapi-bpco.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: APNF MAN Platform - BPCO API Reference
-  version: 1.6.0
+  version: 1.7.0
   license:
     name: CC-BY-SA-4.0
     url: https://creativecommons.org/licenses/by-sa/4.0/legalcode
@@ -69,6 +69,8 @@ info:
     - **MAN Platform Authentication API Reference**, providing the APIs to create access tokens require to authenticate against the APIs listed in this document.
 
     # History
+    **1.7.0** - 2024/09/09
+    - Reorder alphabetically components
 
     **1.6.0** - 2023/12/13
     - (Description) Fix spelling error in 'Rate limiting'
@@ -677,22 +679,84 @@ paths:
         '503':
           $ref: '#/components/responses/ServiceUnavailable'
 components:
+  headers:
+    Content-Length:
+      description: Size in bytes of the response body.
+      schema:
+        type: integer
+        example: 80
+    Content-Length-0:
+      description: Size in bytes of the response body. Always set to 0.
+      schema:
+        type: integer
+        minimum: 0
+        maximum: 0
+        default: 0
+        example: 0
+    Content-Type-Jose-Json:
+      description: Content-Type header set as "application/jose+json".
+      schema:
+        type: string
+        example: application/jose+json
+    Content-Type-Pkix-Crl:
+      description: Content-Type header set as "application/pkix-crl".
+      schema:
+        type: string
+        example: application/pkix-crl
+    Content-Type-TextPlain:
+      description: Content-Type header set as "text/plain".
+      schema:
+        type: string
+        example: text/plain
+    X-Correlation-Id:
+      description: ID generated by the API gateway.
+      schema:
+        $ref: '#/components/schemas/UUID'
+        example: f13371a6-40d7-48cf-a221-794b63fddbd9
+    X-Response-Id:
+      description: Response ID that corresponds to the `X-Request-Id` request header, if provided.
+      schema:
+        $ref: '#/components/schemas/UUID'
+        example: 68831c50-2953-4047-9935-81a98ac1e1e1
+  parameters:
+    CertificateSerialNumber:
+      name: sn
+      in: path
+      description: Certificate serial number
+      required: true
+      schema:
+        type: string
+        pattern: ^([0-9A-Fa-f]{2,40})$
+        example: 57ABB34BCA510043BDE438460F13B27E6A82C004
+    If-Modified-Since:
+      name: If-Modified-Since
+      in: header
+      description: Date in HTTP-Date format (RFC 7231).
+      required: false
+      schema:
+        $ref: '#/components/schemas/RFC7231.HTTP-date'
+    X-Request-Id:
+      name: X-Request-Id
+      in: header
+      description: Request ID that will be returned into the `X-Response-Id` response header.
+      required: false
+      schema:
+        $ref: '#/components/schemas/UUID'
+        example: 68831c50-2953-4047-9935-81a98ac1e1e1
   responses:
-    ErrorValidation:
-      description: Returned when the request input validation failed.
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/ErrorResponse'
+    ErrorInternal:
+      description: Returned when an unexpected error occurred while processing the request.
       headers:
         Content-Length:
-          $ref: '#/components/headers/Content-Length'
+          $ref: '#/components/headers/Content-Length-0'
+        Content-Type:
+          $ref: '#/components/headers/Content-Type-TextPlain'
         X-Correlation-Id:
           $ref: '#/components/headers/X-Correlation-Id'
         X-Response-Id:
           $ref: '#/components/headers/X-Response-Id'
-    ErrorNotFound:
-      description: Returned when the object referenced by the API request does not exist.
+    ErrorInvalidAcceptHeader:
+      description: Returned when the client specifies a type in `Accept` HTTP header not supported.
       headers:
         Content-Length:
           $ref: '#/components/headers/Content-Length-0'
@@ -713,8 +777,8 @@ components:
           $ref: '#/components/headers/X-Correlation-Id'
         X-Response-Id:
           $ref: '#/components/headers/X-Response-Id'
-    ErrorInvalidAcceptHeader:
-      description: Returned when the client specifies a type in `Accept` HTTP header not supported.
+    ErrorNotFound:
+      description: Returned when the object referenced by the API request does not exist.
       headers:
         Content-Length:
           $ref: '#/components/headers/Content-Length-0'
@@ -735,13 +799,15 @@ components:
           $ref: '#/components/headers/X-Correlation-Id'
         X-Response-Id:
           $ref: '#/components/headers/X-Response-Id'
-    ErrorInternal:
-      description: Returned when an unexpected error occurred while processing the request.
+    ErrorValidation:
+      description: Returned when the request input validation failed.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ErrorResponse'
       headers:
         Content-Length:
-          $ref: '#/components/headers/Content-Length-0'
-        Content-Type:
-          $ref: '#/components/headers/Content-Type-TextPlain'
+          $ref: '#/components/headers/Content-Length'
         X-Correlation-Id:
           $ref: '#/components/headers/X-Correlation-Id'
         X-Response-Id:
@@ -767,77 +833,13 @@ components:
         - error
       example:
         error: The request failed.
-    UUID:
-      type: string
-      format: uuid
-      pattern: ^([0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12})$
-      example: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
     RFC7231.HTTP-date:
       type: string
       description: Date format as defined in RFC7231, section 7.1.1.1.
       pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} GMT)$
       example: Mon, 17 Jan 2022 10:12:25 GMT
-  parameters:
-    CertificateSerialNumber:
-      name: sn
-      in: path
-      description: Certificate serial number
-      required: true
-      schema:
-        type: string
-        pattern: ^([0-9A-Fa-f]{2,40})$
-        example: 57ABB34BCA510043BDE438460F13B27E6A82C004
-    If-Modified-Since:
-      name: If-Modified-Since
-      in: header
-      description: Date in HTTP-Date format (RFC 7231).
-      required: false
-      schema:
-        $ref: '#/components/schemas/RFC7231.HTTP-date'
-    X-Request-Id:
-      name: X-Request-Id
-      in: header
-      description: Request ID that will be returned into the `X-Response-Id` response header.
-      required: false
-      schema:
-        $ref: '#/components/schemas/UUID'
-        example: 68831c50-2953-4047-9935-81a98ac1e1e1
-  headers:
-    Content-Type-Jose-Json:
-      description: Content-Type header set as "application/jose+json".
-      schema:
-        type: string
-        example: application/jose+json
-    Content-Type-Pkix-Crl:
-      description: Content-Type header set as "application/pkix-crl".
-      schema:
-        type: string
-        example: application/pkix-crl
-    Content-Type-TextPlain:
-      description: Content-Type header set as "text/plain".
-      schema:
-        type: string
-        example: text/plain
-    Content-Length:
-      description: Size in bytes of the response body.
-      schema:
-        type: integer
-        example: 80
-    Content-Length-0:
-      description: Size in bytes of the response body. Always set to 0.
-      schema:
-        type: integer
-        minimum: 0
-        maximum: 0
-        default: 0
-        example: 0
-    X-Correlation-Id:
-      description: ID generated by the API gateway.
-      schema:
-        $ref: '#/components/schemas/UUID'
-        example: f13371a6-40d7-48cf-a221-794b63fddbd9
-    X-Response-Id:
-      description: Response ID that corresponds to the `X-Request-Id` request header, if provided.
-      schema:
-        $ref: '#/components/schemas/UUID'
-        example: 68831c50-2953-4047-9935-81a98ac1e1e1
+    UUID:
+      type: string
+      format: uuid
+      pattern: ^([0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12})$
+      example: cc4519cb-b2b6-45ad-904c-7698fdf72ba2