Versions Compared

Old Version 9

changes.mady.by.user Joseph Keenan

Saved on

compared with

New Version 10

changes.mady.by.user Joseph Keenan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


IssueNotesDecision
1Does request body need to declare "publicCmHandleProperties"?

Do we need to explcitly declare "publicCmHandleProperties"? 

Will there be another possible variation to this in the future?

Code Block
languageyml
{
  "publicCmHandleProperties" : {           
        "module1": "revision1",
		"module2": "revision2"    }
}


Not another variation but there will be "modules" included in future implementations.
2Do we need to consider if cm handle exists?

3



Analysis

...

High level steps:

...

Below is a sample yaml for OpenAPI.

Note: Will update to take in custom type and not ModuleReference.

Code Block
languageyml
titleSample OpenAPI yAML
collapsetrue
executeSearchForMatchingPublicProperties:
  post:
    description: Execute search to get all cm handles for the given public properties
    tags:
      - network-cm-proxy
    summary: Execute cm handle search using
    operationId: executeSearchForMatchingPublicProperties
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: 'components.yaml#/components/schemas/ModuleReferencePublicProperties'
    responses:
      200:
        description: OK
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      400:
        $ref: 'components.yaml#/components/responses/BadRequest'
      401:
        $ref: 'components.yaml#/components/responses/Unauthorized'
      403:
        $ref: 'components.yaml#/components/responses/Forbidden'
      404:
        $ref: 'components.yaml#/components/responses/NotFound'
      500:
        $ref: 'components.yaml#/components/responses/InternalServerError'

...