Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[📑 Docs]: Adapt Server Security tutorial for v3 #1860

Closed
jonaslagoni opened this issue Jun 28, 2023 · 1 comment
Closed

[📑 Docs]: Adapt Server Security tutorial for v3 #1860

jonaslagoni opened this issue Jun 28, 2023 · 1 comment
Assignees
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers

Comments

@jonaslagoni
Copy link
Member

jonaslagoni commented Jun 28, 2023

For AsyncAPI v3, we need to adapt the AsyncAPI Documents tutorial (https://www.asyncapi.com/docs/tutorials/getting-started/security) to be usable with AsyncAPI v3.

Here are the v3 structure that should be used instead:

asyncapi: 3.0.0
info:
  title: Hello world application
  version: '0.1.0'

servers:
  production:
    host: broker.mycompany.com
    protocol: amqp
    description: This is "My Company" broker.
    security:
      - $ref: "#/components/securitySchemes/user-password"

channels:
  hello:
    address: 'hello'
    messages:
      sayHelloMessage:
        $ref: '#/components/messages/hello-msg'

  goodbye:
    address: 'goodbye'
    messages:
      sayGoodbyeMessage:
        $ref: '#/components/messages/goodbye-msg'

operations:
  receiveHello:
    action: 'receive'
    channel:
      $ref: '#/channels/hello'

  receiveGoodbye:
    action: 'receive'
    channel:
      $ref: '#/channels/goodbye'

components:
  messages:
    hello-msg:
      payload:
        type: object
        properties:
          name:
            type: string
          sentAt:
            $ref: '#/components/schemas/sent-at'
    goodbye-msg:
      payload:
        type: object
        properties:
          sentAt:
            $ref: '#/components/schemas/sent-at'

  schemas:
    sent-at:
      type: string
      description: The date and time a message was sent.
      format: datetime
  securitySchemes:
    user-password:
      type: userPassword

Here are the main points that need to change:

  • Re-add the docs/tutorials/getting-started/security.md file.
  • Adapt the AsyncAPI code snippet
  • Adapt the text if anything is needed.

Make sure you base your change on the next-major-spec branch and target it in your PR 🙂 If you have any questions, don't hesitate to ask.

@quetzalliwrites quetzalliwrites added good first issue Good for newcomers 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Jun 29, 2023
@quetzalliwrites quetzalliwrites changed the title [📑 Docs]: Adapt Servers tutorial for v3 [📑 Docs]: Adapt Server Security tutorial for v3 Aug 31, 2023
@derberg
Copy link
Member

derberg commented Nov 13, 2023

solved with #2305
in next major branch, but considered to be fixed and closing - also for easier management of the scope for v3

@derberg derberg closed this as completed Nov 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers
Projects
Status: Changes proposed 📄
Development

No branches or pull requests

3 participants