Commit ebe95b1d authored by Saurav Arora's avatar Saurav Arora
Browse files

CT #84

parent 65719aa2

TS29222_AEF_Security_API.yaml

+7 −4
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: AEF_Security_API

  description: This API allows an API invoker to check if the security information required by the API exposing function is available, by initiating authentication. This API also allows CAPIF core function to revoke access to service APIs.

  version: "1.0.0"

  description: |

    API for AEF security management.

    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

  version: "1.0.1"

externalDocs:

  description: 3GPP TS 29.222 V15.2.0 Common API Framework for 3GPP Northbound APIs

  description: 3GPP TS 29.222 V15.4.0 Common API Framework for 3GPP Northbound APIs

  url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.222/

servers:

  - url: '{apiRoot}/aef-security/v1'

TS29222_CAPIF_API_Invoker_Management_API.yaml

+7 −4
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: CAPIF_API_Invoker_Management_API

  description: This API enables the API invoker to communicate with the CAPIF core function to negotiate security methods and obtain authorizations to access service APIs.

  version: "1.0.0"

  description: |

    API for API invoker management.

    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

  version: "1.0.1"

externalDocs:

  description: 3GPP TS 29.222 V15.2.0 Common API Framework for 3GPP Northbound APIs

  description: 3GPP TS 29.222 V15.4.0 Common API Framework for 3GPP Northbound APIs

  url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.222/

servers:

  - url: '{apiRoot}/api-invoker-management/v1'

TS29222_CAPIF_Access_Control_Policy_API.yaml

+7 −4
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: CAPIF_Access_Control_Policy_API

  description: This API enables the API exposing function to obtain the policy to perform access control on the service API invocations.

  version: "1.0.0"

  description: |

    API for access control policy.

    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

  version: "1.0.1"

externalDocs:

  description: 3GPP TS 29.222 V15.2.0 Common API Framework for 3GPP Northbound APIs

  description: 3GPP TS 29.222 V15.4.0 Common API Framework for 3GPP Northbound APIs

  url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.222/

servers:

  - url: '{apiRoot}/access-control-policy/v1'

TS29222_CAPIF_Auditing_API.yaml

+8 −5
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: CAPIF_Auditing_API

  description: This API enables the API management function to communicate with the CAPIF core function to retrieve the log information related to service API invocations.

  version: "1.0.0"

  description: |

    API for auditing.

    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

  version: "1.0.1"

externalDocs:

  description: 3GPP TS 29.222 V15.2.0 Common API Framework for 3GPP Northbound APIs

  description: 3GPP TS 29.222 V15.4.0 Common API Framework for 3GPP Northbound APIs

  url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.222/

servers:

  - url: '{apiRoot}/logs/v1'
@@ -44,7 +47,7 @@ paths: 
            type: string

        - name: api-name

          in: query

          description: API name, it is set as {apiName} part of the URI structure as defined in subclause 4.4 of 3GPP TS 29.501.

          description: API name, it is set as {apiName} part of the URI structure as defined in subclause 4.4 of 3GPP TS 29.501.

          schema:

            type: string

        - name: api-version

TS29222_CAPIF_Discover_Service_API.yaml

+8 −5
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: CAPIF_Discover_Service_API

  description: This API enables the API invoker to communicate with the CAPIF core function to discover the published service API information.

  version: "1.0.0"

  description: |

    API for discovering service APIs.

    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

  version: "1.0.1"

externalDocs:

  description: 3GPP TS 29.222 V15.2.0 Common API Framework for 3GPP Northbound APIs

  description: 3GPP TS 29.222 V15.4.0 Common API Framework for 3GPP Northbound APIs

  url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.222/

servers:

  - url: '{apiRoot}/service-apis/v1'
@@ -25,7 +28,7 @@ paths: 
            type: string

        - name: api-name

          in: query

          description: API name, it is set as {apiName} part of the URI structure as defined in subclause 4.4 of 3GPP TS 29.501 [18].

          description: API name, it is set as {apiName} part of the URI structure as defined in subclause 4.4 of 3GPP TS 29.501 [18].

          schema:

            type: string

        - name: api-version