swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Gov API
schemes:
- https
tags:
- name: Gov
paths:
  /gov/members/proposals:
    get:
      operationId: microsoftAzureProposalsList
      description: Returns all current proposed changes to the service. Note that non-open proposals (ie - those which have already been accepted, rejected, withdrawn, etc) are not returned.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedProposal'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Proposals_List:
          $ref: ./examples/Proposals_List.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Gov Members Proposals
      tags:
      - Gov
  /gov/members/proposals/{proposalId}:withdraw:
    post:
      operationId: microsoftAzureProposalsWithdraw
      description: Withdraw an existing proposal. Only the original proposer is permitted to withdraw.
      consumes:
      - application/cose
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: proposalId
        in: path
        description: Unique ID assigned to this proposal at its submission, by the service.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      - $ref: '#/parameters/CoseSignature.body'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Proposals.Proposal'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Proposals_Withdraw:
          $ref: ./examples/Proposals_Withdraw.json
      summary: Microsoft Azure Post Gov Members Proposals Proposalid:withdraw
      tags:
      - Gov
  /gov/members/proposals/{proposalId}:
    get:
      operationId: microsoftAzureProposalsGet
      description: Returns a summary of a single proposed change to the service.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: proposalId
        in: path
        description: Unique ID assigned to this proposal at its submission, by the service.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Proposals.Proposal'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Proposals_Get:
          $ref: ./examples/Proposals_Get.json
      summary: Microsoft Azure Get Gov Members Proposals Proposalid
      tags:
      - Gov
  /gov/members/proposals/{proposalId}/actions:
    get:
      operationId: microsoftAzureProposalsGetactions
      description: Returns actions contained in a proposal.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: proposalId
        in: path
        description: Unique ID assigned to this proposal at its submission, by the service.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Proposals.ProposalActions'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Proposals_GetActions:
          $ref: ./examples/Proposals_GetActions.json
      summary: Microsoft Azure Get Gov Members Proposals Proposalid Actions
      tags:
      - Gov
  /gov/members/proposals/{proposalId}/ballots/{memberId}:submit:
    post:
      operationId: microsoftAzureBallotsSubmit
      description: Submit an executable ballot for a specific proposal. This may be as simple as `return true` to vote in favour, or contain reads from the KV and conditions on the proposal contents.
      consumes:
      - application/cose
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: proposalId
        in: path
        description: Unique ID assigned to this proposal at its submission, by the service.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      - name: memberId
        in: path
        description: ID of CCF member who signed and submitted this ballot.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      - $ref: '#/parameters/CoseSignature.body'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Proposals.Proposal'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Ballots_Submit:
          $ref: ./examples/Ballots_Submit.json
      summary: Microsoft Azure Post Gov Members Proposals Proposalid Ballots Memberid:submit
      tags:
      - Gov
  /gov/members/proposals/{proposalId}/ballots/{memberId}:
    get:
      operationId: microsoftAzureBallotsGet
      description: Returns a member's submitted ballot.
      produces:
      - text/javascript
      - application/json
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: proposalId
        in: path
        description: Unique ID assigned to this proposal at its submission, by the service.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      - name: memberId
        in: path
        description: ID of CCF member who signed and submitted this ballot.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Proposals.Ballot'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Ballots_Get:
          $ref: ./examples/Ballots_Get.json
      summary: Microsoft Azure Get Gov Members Proposals Proposalid Ballots Memberid
      tags:
      - Gov
  /gov/members/proposals:create:
    post:
      operationId: microsoftAzureProposalsCreate
      description: Submit a proposed change to the service. This will be assigned an ID by the service. Submitting the same signature (including signed COSE headers such as created_at) multiple times will be treated as a single idempotent operation, returning a single created proposal (or an error if it is no longer available). Any change to the request body will be treated as a new, separate proposal.
      consumes:
      - application/cose
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/CoseSignature.body'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Proposals.Proposal'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Proposals_Create:
          $ref: ./examples/Proposals_Create.json
      summary: Microsoft Azure Post Gov Members Proposals:create
      tags:
      - Gov
  /gov/members/state-digests/{memberId}:update:
    post:
      operationId: microsoftAzureStatedigestsUpdate
      description: Request that this member's stateDigest is updated to a fresher value. Only this member may update their own stateDigest. Returns the refreshed value.
      consumes:
      - application/cose
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: memberId
        in: path
        description: Identifier for member this stateDigest applies to.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      - $ref: '#/parameters/CoseSignature.body'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Acks.StateDigest'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        StateDigests_Update:
          $ref: ./examples/StateDigests_Update.json
      summary: Microsoft Azure Post Gov Members State Digests Memberid:update
      tags:
      - Gov
  /gov/members/state-digests/{memberId}:ack:
    post:
      operationId: microsoftAzureStatedigestsAcknowledge
      description: Submit a signed acknowledgement of a recent digest of the service status, to transition the member to Active.
      consumes:
      - application/cose
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: memberId
        in: path
        description: Identifier for member this stateDigest applies to.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      - $ref: '#/parameters/CoseSignature.body'
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        StateDigests_Acknowledge:
          $ref: ./examples/StateDigests_Acknowledge.json
      summary: Microsoft Azure Post Gov Members State Digests Memberid:ack
      tags:
      - Gov
  /gov/members/state-digests/{memberId}:
    get:
      operationId: microsoftAzureStatedigestsGet
      description: Get the stateDigest assigned to the given member, which that member must sign to become active.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: memberId
        in: path
        description: Identifier for member this stateDigest applies to.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Acks.StateDigest'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        StateDigests_Get:
          $ref: ./examples/StateDigests_Get.json
      summary: Microsoft Azure Get Gov Members State Digests Memberid
      tags:
      - Gov
  /gov/recovery/encrypted-shares/{memberId}:
    get:
      operationId: microsoftAzureEncryptedsharesGet
      description: Retrieve a member's recovery share, encrypted with that member's share-encryption key.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: memberId
        in: path
        description: ID of CCF member who this recovery share belongs to.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Recovery.EncryptedRecoveryShare'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        EncryptedShares_Get:
          $ref: ./examples/EncryptedShares_Get.json
      summary: Microsoft Azure Get Gov Recovery Encrypted Shares Memberid
      tags:
      - Gov
  /gov/recovery/members/{memberId}:recover:
    post:
      operationId: microsoftAzureSharesSubmit
      description: Provide a recovery share for the purpose of completing a service recovery.
      consumes:
      - application/cose
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: memberId
        in: path
        description: Identifier for member this recovery state applies to.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      - $ref: '#/parameters/CoseSignature.body'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Recovery.RecoveryResponse'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Shares_Submit:
          $ref: ./examples/Shares_Submit.json
      summary: Microsoft Azure Post Gov Recovery Members Memberid:recover
      tags:
      - Gov
  /gov/service/constitution:
    get:
      operationId: microsoftAzureServicestateGetconstitution
      description: Retrieve the constitution which controls governance changes on this service.
      produces:
      - text/javascript
      - application/json
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ServiceState.ConstitutionResponse'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        ServiceState_GetConstitution:
          $ref: ./examples/ServiceState_GetConstitution.json
      summary: Microsoft Azure Get Gov Service Constitution
      tags:
      - Gov
  /gov/service/info:
    get:
      operationId: microsoftAzureServicestateGetserviceinfo
      description: Returns general information about the service, including whether it is a recovery or original service.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ServiceState.ServiceInfo'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        ServiceState_GetServiceInfo:
          $ref: ./examples/ServiceState_GetServiceInfo.json
      summary: Microsoft Azure Get Gov Service Info
      tags:
      - Gov
  /gov/service/javascript-app:
    get:
      operationId: microsoftAzureServicestateGetjsapp
      description: Retrieve details of Javascript application and execution engine.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ServiceState.JsApp'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        ServiceState_GetJsApp:
          $ref: ./examples/ServiceState_GetJsApp.json
      summary: Microsoft Azure Get Gov Service Javascript App
      tags:
      - Gov
  /gov/service/join-policy:
    get:
      operationId: microsoftAzureServicestateGetjoinpolicies
      description: Retrieve policy data which determines whether new nodes are permitted to join the service. This describes the hardware attestations which are acceptable to the service, demonstrating a joining node is running approved code.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ServiceState.JoinPolicies'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        ServiceState_GetJoinPolicies:
          $ref: ./examples/ServiceState_GetJoinPolicies.json
      summary: Microsoft Azure Get Gov Service Join Policy
      tags:
      - Gov
  /gov/service/jwk:
    get:
      operationId: microsoftAzureServicestateGetjwkinfo
      description: Returns information about OpenID Connect identity providers.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ServiceState.JwkInfo'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        ServiceState_GetJwkInfo:
          $ref: ./examples/ServiceState_GetJwkInfo.json
      summary: Microsoft Azure Get Gov Service Jwk
      tags:
      - Gov
  /gov/service/members:
    get:
      operationId: microsoftAzureServicestateListmembers
      description: Retrieve list of all members who govern this service.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedMember'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        ServiceState_ListMembers:
          $ref: ./examples/ServiceState_ListMembers.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Gov Service Members
      tags:
      - Gov
  /gov/service/members/{memberId}:
    get:
      operationId: microsoftAzureServicestateGetmember
      description: Retrieve a single governing member, by ID.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: memberId
        in: path
        description: ID of CCF member who this object refers to.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ServiceState.Member'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        ServiceState_GetMember:
          $ref: ./examples/ServiceState_GetMember.json
      summary: Microsoft Azure Get Gov Service Members Memberid
      tags:
      - Gov
  /gov/service/nodes:
    get:
      operationId: microsoftAzureServicestateListnodes
      description: Retrieve list of all nodes participating in this service.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedNode'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        ServiceState_ListNodes:
          $ref: ./examples/ServiceState_ListNodes.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Gov Service Nodes
      tags:
      - Gov
  /gov/service/nodes/{nodeId}:
    get:
      operationId: microsoftAzureServicestateGetnode
      description: Retrieve a single node, by ID.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: nodeId
        in: path
        description: ID of CCF node who this object refers to.
        required: true
        type: string
        pattern: ^[a-f0-9]{64}$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ServiceState.Node'
          headers:
            x-ms-ccf-transaction-id:
              type: string
              description: Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.
              pattern: ^[0-9]+\.[0-9]+$
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        ServiceState_GetNode:
          $ref: ./examples/ServiceState_GetNode.json
      summary: Microsoft Azure Get Gov Service Nodes Nodeid
      tags:
      - Gov
  /gov/service/transactions/{transactionId}:
    get:
      operationId: microsoftAzureTransactionsGet
      description: Get status of transaction by transaction ID, to determine whether it has committed.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: transactionId
        in: path
        description: Identifier of the requested transaction.
        required: true
        type: string
        pattern: ^[0-9]+\.[0-9]+$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Transactions.Transaction'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Transactions_Get:
          $ref: ./examples/Transactions_Get.json
      summary: Microsoft Azure Get Gov Service Transactions Transactionid
      tags:
      - Gov
  /gov/service/transactions/commit:
    get:
      operationId: microsoftAzureTransactionsGetcommit
      description: Get latest committed transaction.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Transactions.CommittedTransaction'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Transactions_GetCommit:
          $ref: ./examples/Transactions_GetCommit.json
      summary: Microsoft Azure Get Gov Service Transactions Commit
      tags:
      - Gov
definitions:
  Transactions.Transaction:
    type: object
    description: Common transaction information.
    properties:
      status:
        $ref: '#/definitions/Transactions.TransactionStatus'
        description: Status of this transaction.
    required:
    - status
  ServiceState.JwkInfo:
    type: object
    description: Describes what Javascript Web Tokens (JWTs) are accepted by the service, and how they will be validated.
    properties:
      issuers:
        type: object
        description: Collection of JWT issuers. Keyed by issuer ID.
        additionalProperties:
          $ref: '#/definitions/ServiceState.JwtIssuer'
      caCertBundles:
        type: object
        description: Collection of CAs used to authenticate connections with issuers. Keyed by governance-controlled bundle names.
        additionalProperties:
          $ref: '#/definitions/ServiceState.caCertBundle'
    required:
    - issuers
    - caCertBundles
  ServiceState.ForwardingRequired:
    type: string
    description: Describes the forwarding behavior of a specific endpoint. Write requests cannot be executed on a backup, so will generally be forwarded by any backup node which receives them to the current primary. Future requests on the same session may then be forwarded to maintain session consistency.
    enum:
    - Sometimes
    - Always
    - Never
    x-ms-enum:
      name: ForwardingRequired
      modelAsString: true
      values:
      - name: Sometimes
        value: Sometimes
        description: Indicates that this request should be forwarded if-and-only-if it is needed to maintain session consistency. If stale reads are acceptable then they can be completed on a backup, and the request will not be forwarded. This should be the default behavior for read-only endpoints.
      - name: Always
        value: Always
        description: Indicates that this request should always be forwarded. This will trigger forwarding of any additional requests on the same session, even those marked ForwardRequired::Sometimes. This should be the default behavior for any endpoint which writes to the Key-Value store.
      - name: Never
        value: Never
        description: Indicates endpoints which will never be forwarded, even when this will result in a break of session consistency. This should be used only to access node-local information, or when weaker consistency is acceptable.
  ServiceState.SnpJoinPolicy:
    type: object
    description: Join policy fields specific to nodes running on AMD SEV-SNP hardware.
    properties:
      measurements:
        type: array
        description: Code measurements of acceptable enclaves.
        items:
          type: string
          format: byte
      hostData:
        type: object
        description: Collection of acceptable host data values.
        additionalProperties:
          format: byte
          type: string
      uvmEndorsements:
        type: object
        description: Collection of acceptable UVM endorsements.
        additionalProperties:
          format: byte
          type: string
    required:
    - measurements
    - hostData
    - uvmEndorsements
  Proposals.ProposalState:
    type: string
    description: Possible states for a proposal.
    enum:
    - Open
    - Accepted
    - Withdrawn
    - Rejected
    - Failed
    - Dropped
    x-ms-enum:
      name: ProposalState
      modelAsString: true
      values:
      - name: Open
        value: Open
        description: Proposal is active and can be voted on.
      - name: Accepted
        value: Accepted
        description: Proposal passed a successful vote and was enacted.
      - name: Withdrawn
        value: Withdrawn
        description: Proposal was removed by proposing member. Will never be enacted.
      - name: Rejected
        value: Rejected
        description: Proposal was rejected by vote. Will never be enacted.
      - name: Failed
        value: Failed
        description: Proposal passed a successful vote, but its proposed actions failed. Will never be enacted.
      - name: Dropped
        value: Dropped
        description: Proposal was open when its semantics were potentially changed (code or constitution were modified), so it was automatically invalidated.
  Proposals.VoteFailures:
    type: object
    description: Each key is a memberId, and the corresponding value explains why execution of their ballot failed.
    additionalProperties:
      $ref: '#/definitions/Proposals.FailureInfo'
  Proposals.Action:
    type: object
    description: A single step in a proposed change to the service.
    properties:
      name:
        type: string
        description: The name of the action to perform. This should match an action defined in the service's constitution, so that it can be invoked by the `apply` function of the constitution if the proposal is accepted.
      args:
        description: Arguments to modify the behavior of this action. The schema is determined by the action implementation, and should be validated by a `validate` call in the constitution.
    required:
    - name
  ServiceState.JoinPolicy:
    type: object
    description: Describes what a joining node must present, in order to join the service.
    properties:
      measurements:
        type: array
        description: Code measurements of acceptable enclaves.
        items:
          type: string
          format: byte
    required:
    - measurements
  ServiceState.JsEndpointInfo:
    type: object
    description: Describes an endpoint implemented by a Javascript handler.
    properties:
      jsModule:
        type: string
        description: The name of the module where the endpoint function is located.
      jsFunction:
        type: string
        description: The name of the exported function which implements this endpoint.
      forwardingRequired:
        $ref: '#/definitions/ServiceState.ForwardingRequired'
        description: Describes whether requests to this endpoint should be forwarded to the primary or executed on backups.
      authnPolicies:
        type: array
        description: The authentication policies which restrict access to this endpoint
        items:
          type: string
      mode:
        $ref: '#/definitions/ServiceState.JsExecMode'
        description: Describes how this endpoint should be executed.
      openApi:
        type: object
        description: An OpenAPI Operation object (https://swagger.io/specification/#operation-object) describing this operation. This is merged into the auto-generated OpenAPI to describe the current application's API.
        additionalProperties: {}
    required:
    - jsModule
    - jsFunction
    - forwardingRequired
    - authnPolicies
    - mode
    - openApi
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
  Proposals.Proposal:
    type: object
    description: Description of a proposed change to the service.
    properties:
      proposalId:
        $ref: '#/definitions/proposalId'
        description: Unique ID assigned to this proposal at its submission, by the service.
      proposerId:
        $ref: '#/definitions/memberId'
        description: ID of CCF member who signed and created this proposal.
      proposalState:
        $ref: '#/definitions/Proposals.ProposalState'
        description: Current state of this proposal.
      ballotCount:
        $ref: '#/definitions/safeuint'
        description: Count of how many ballots have been submitted for this proposal.
      finalVotes:
        $ref: '#/definitions/Proposals.MemberVotes'
        description: If a proposal is not open, then this contains the result of each ballot when the proposal transitioned from open.
      voteFailures:
        $ref: '#/definitions/Proposals.VoteFailures'
        description: This will be populated with a description of any ballots which failed to execute.
      failure:
        $ref: '#/definitions/Proposals.FailureInfo'
        description: If proposalState is Failure, then this will describe why the proposal failed.
    required:
    - proposalId
    - proposerId
    - proposalState
    - ballotCount
  ServiceState.caCertBundle:
    type: string
    description: Chain of endorsed certificates (PEM format) leading to a CA.
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  ServiceState.ServiceStatus:
    type: string
    description: State machine values for current service lifetime. New services start in Opening, and transition to Open via a governance proposal. They will only accept user transactions on the `/app` endpoints once they are Open. Recovery services have additional states where they must wait for members to submit sufficient recovery shares to access the previous ledger secrets, and while they are decrypting and replaying the previous ledger contents.
    enum:
    - Opening
    - Open
    - WaitingForRecoveryShares
    - Recovering
    x-ms-enum:
      name: ServiceStatus
      modelAsString: true
      values:
      - name: Opening
        value: Opening
        description: Services which have not yet passed a `transition_service_to_open` proposal.
      - name: Open
        value: Open
        description: Services which are operating normally and accepting user transactions.
      - name: WaitingForRecoveryShares
        value: WaitingForRecoveryShares
        description: Recovered services which cannot yet access private state.
      - name: Recovering
        value: Recovering
        description: Recovered services which are actively replaying transactions from previous service, to reach the same state.
  ServiceState.Node:
    type: object
    description: Information on individual nodes within a service.
    properties:
      nodeId:
        $ref: '#/definitions/nodeId'
        description: ID of CCF node who this object refers to.
      status:
        $ref: '#/definitions/ServiceState.NodeStatus'
        description: Current status of this node.
      nodeData:
        description: Arbitrary service-defined metadata about this node. May be used by constitution or application code, but will not affect any core framework decisions.
      certificate:
        $ref: '#/definitions/ServiceState.pem'
        description: x509 certificate containing this node's identity.
      retiredCommitted:
        type: boolean
        description: This is false during node's normal operation. It transitions to true once the node has been retired, and that retirement has been committed by the service. At this point it is safe to terminate a node. Terminating a node any earlier may affect liveness of the service.
      quoteInfo:
        $ref: '#/definitions/ServiceState.QuoteInfo'
        description: Contains this node's hardware attestation. This is generated during node startup, and must meet the current join policy restrictions for the node to successfully join a service.
      rpcInterfaces:
        type: object
        description: A collection of interfaces by which this node may be contacted. Some may be limited to private networks, and others may be DNS names or internet-public network addresses. The keys are arbitrary strings determined by the node operator.
        additionalProperties:
          $ref: '#/definitions/ServiceState.NetworkInterface'
    required:
    - nodeId
    - status
    - certificate
    - retiredCommitted
    - quoteInfo
    - rpcInterfaces
  Recovery.RecoveryResponse:
    type: object
    description: Response to a submitted recovery share.
    properties:
      message:
        type: string
        description: Human-readable description of current recovery progress.
      submittedCount:
        $ref: '#/definitions/safeuint'
        description: Count of how many accepted member shares have been submitted, including the current request.
      recoveryThreshold:
        $ref: '#/definitions/safeuint'
        description: Count of how many member shares are required to initiate the end-of-recovery procedure.
    required:
    - message
    - submittedCount
    - recoveryThreshold
  transactionId:
    type: string
    description: Uniquely identifies an atomic transaction within a CCF service. Composed of a term number and sequence number. Sequence numbers increase monotonically, apart from during elections where the service may reuse an existing sequence number. Each election will result in a new, higher term number being used for the conflicting and future sequence numbers.
    pattern: ^[0-9]+\.[0-9]+$
  ServiceState.QuoteInfo:
    type: object
    description: Common type for attestation information, describing the cryptographically-endorsed claim of what code is executing, and what platform it is executing on. Derived types contain platform-specific details.
    properties:
      format:
        type: string
        description: Discriminator property for QuoteInfo.
    discriminator: format
    required:
    - format
  nodeId:
    type: string
    description: Hex encoding of SHA-256 of a node's public key.
    pattern: ^[a-f0-9]{64}$
  ServiceState.ServiceInfo:
    type: object
    description: General information about the current service.
    properties:
      status:
        $ref: '#/definitions/ServiceState.ServiceStatus'
        description: Lifetime stage of the service.
      certificate:
        $ref: '#/definitions/ServiceState.pem'
        description: The current service identity. This is the public face of a secret key shared only by the nodes within the service, and should be used to authenticate TLS sessions with this service.
      recoveryCount:
        $ref: '#/definitions/safeuint'
        description: Records how many predecessors this service has. While the service identity certificate will change on any recovery, this allows users to determine exactly how many such recoveries have occurred.
      creationTransactionId:
        $ref: '#/definitions/transactionId'
        description: Transaction ID at which this service was first created. If this is a recovery of a previous service, this will indicate when the current service was recovered.
      previousServiceCreationTransactionId:
        $ref: '#/definitions/ServiceState.pem'
        description: Transaction ID at which the predecessor service was created, if this service is a recovery. If this is an original service rather than a recovery, this will be omitted.
      serviceData:
        description: Arbitrary service-defined metadata about this service. May be used by constitution or application code, but will not affect any core framework decisions.
      configuration:
        type: object
        description: Lists governance-controlled configuration parameters of this service, which will be used by core framework code.
        properties:
          maximumNodeCertificateValidityDays:
            $ref: '#/definitions/safeuint'
          recentCoseProposalsWindowSize:
            $ref: '#/definitions/safeuint'
        required:
        - maximumNodeCertificateValidityDays
        - recentCoseProposalsWindowSize
    required:
    - status
    - certificate
    - recoveryCount
    - creationTransactionId
    - configuration
  ServiceState.Member:
    type: object
    description: Information on individual members within a consortium.
    properties:
      memberId:
        $ref: '#/definitions/memberId'
        description: ID of CCF member who this object refers to.
      status:
        $ref: '#/definitions/ServiceState.MemberStatus'
        description: Current status of this member.
      memberData:
        description: Arbitrary service-defined metadata about this member. May be used by constitution or application code, but will not affect any core framework decisions.
      certificate:
        $ref: '#/definitions/ServiceState.pem'
        description: x509 certificate used as this member's identity.
    required:
    - memberId
    - status
    - certificate
  ServiceState.pem:
    type: string
    description: PEM encoding of a cryptographic identifier. Contains a base64-encoded payload wrapped in content type identifiers.
  ServiceState.NetworkInterface:
    type: object
    description: Details of how to contact a CCF node. Each node may listen on multiple interfaces, for different kinds of traffic.
    properties:
      publishedAddress:
        type: string
        description: The network address where this node believes it is publicly accessible, in the format <host>[:<port>].
      protocol:
        type: string
        description: The application layer protocol which the node expects on this interface. Currently supports "http1" and "http2", more protocols may be added in future.
    required:
    - publishedAddress
    - protocol
  Acks.StateDigest:
    type: object
    description: A compact summary of the service's state up to a certain point in time, updated and signed by members to indicate their participation in and approval of the service.
    properties:
      digest:
        type: string
        description: Hex-encoding of SHA-256 hash of the root of the service's merkle tree. This should be signed by a new member and submitted as an ACK to mark that member as Active.
        pattern: ^[a-f0-9]{64}$
    required:
    - digest
  PagedProposal:
    type: object
    description: Paged collection of Proposal items
    properties:
      value:
        type: array
        description: The Proposal items on this page
        items:
          $ref: '#/definitions/Proposals.Proposal'
        x-ms-identifiers: []
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  Proposals.Ballot:
    type: object
    description: The source script of an executable vote from a member, regarding a proposed change to the service.
    properties:
      script:
        type: string
        description: The script to execute, returning the voter's support of this proposal.
    required:
    - script
  ServiceState.JoinPolicies:
    type: object
    description: Collection of all policies which determine currently acceptable nodes, across multiple platforms.
    properties:
      sgx:
        $ref: '#/definitions/ServiceState.JoinPolicy'
        description: Policy applied to nodes running in SGX enclaves.
      snp:
        $ref: '#/definitions/ServiceState.SnpJoinPolicy'
        description: Policy applied to nodes running in AMD SEV-SNP containers.
    required:
    - sgx
    - snp
  ServiceState.JwtIssuer:
    type: object
    description: Description of a JWT issuer or identity provider that the current service will trust tokens from.
    properties:
      keyFilter:
        $ref: '#/definitions/ServiceState.JwtIssuerKeyFilter'
        description: Adds restrictions on whether keys should be accepted from this issuer.
      keyPolicy:
        type: object
        description: Collection of claims which must be present in SGX attestation to permit updates from this issuer.
        additionalProperties:
          type: string
      autoRefresh:
        type: boolean
        description: Whether this issuer's keys are periodically refreshed with a fetch from the current primary. If false, these will only be updated by governance.
      caCertBundleName:
        type: string
        description: Name of bundle used to authenticate issuer when auto-refreshing.
    required:
    - keyFilter
    - autoRefresh
  Azure.Core.Foundations.InnerError:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  ServiceState.NodeStatus:
    type: string
    description: Lifecycle state of a CCF node. Nodes will generally start as Pending, then transition to Trusted, then to Retired. They are only full participants in the service while they are Trusted.
    enum:
    - Pending
    - Trusted
    - Retired
    x-ms-enum:
      name: NodeStatus
      modelAsString: true
      values:
      - name: Pending
        value: Pending
        description: Indicates a node which has successfully completed a join request to the service (including attestation checks), but has not yet been approved by governance.
      - name: Trusted
        value: Trusted
        description: Indicates a node which has been approved by governance, and is a full participant in the service.
      - name: Retired
        value: Retired
        description: Indicates a node which has been removed from a service by a reconfiguration.
  ServiceState.JsOperations:
    type: object
    description: The collection of operations available on each path. Keyed by HTTP method.
    additionalProperties:
      $ref: '#/definitions/ServiceState.JsEndpointInfo'
  PagedNode:
    type: object
    description: Paged collection of Node items
    properties:
      value:
        type: array
        description: The Node items on this page
        items:
          $ref: '#/definitions/ServiceState.Node'
        x-ms-identifiers: []
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  Transactions.TransactionStatus:
    type: string
    description: 'Possible states for a CCF transaction. See docs for details: https://microsoft.github.io/CCF/main/use_apps/verify_tx.html#checking-for-commit'
    enum:
    - Unknown
    - Pending
    - Committed
    - Invalid
    x-ms-enum:
      name: TransactionStatus
      modelAsString: true
      values:
      - name: Unknown
        value: Unknown
        description: This is not a transaction the current node knows, but could exist in future. This may be returned when a transaction is created on one node then immediately queried on another, before it has been replicated.
      - name: Pending
        value: Pending
        description: This transaction is known on the current node, but has not yet been committed. This is expected to be a temporary state.
      - name: Committed
        value: Committed
        description: This transaction is known on the current node, and known to be committed. This means it has been replicated to a quorum of nodes, so will persist through future elections. Committed is a terminal state of this state machine.
      - name: Invalid
        value: Invalid
        description: This transaction ID will never commit in the current service, because it contains a different term than a known transaction with the same sequence number. This can occur for a transaction ID returned from the service (ie - which was previously Unknown or Pending), if that transaction is lost during a consensus election. This should be rare. Invalid is a terminal state of this state machine.
  ServiceState.JwtIssuerKeyFilter:
    type: string
    description: Possible restrictions on what keys will be accepted from a JWT issuer.
    enum:
    - All
    - Sgx
    x-ms-enum:
      name: JwtIssuerKeyFilter
      modelAsString: true
      values:
      - name: All
        value: All
        description: Accepts any JWT issuer.
      - name: Sgx
        value: Sgx
        description: Only accepts JWTs issued by a token provider running in SGX, which provides a suitable attestation and additional claims.
  ServiceState.MemberStatus:
    type: string
    description: Possible states for a CCF governing member.
    enum:
    - Accepted
    - Active
    x-ms-enum:
      name: MemberStatus
      modelAsString: true
      values:
      - name: Accepted
        value: Accepted
        description: Member has been approved to join the service, but have not yet submitted an ACK to indicate their participation. These members should not be considered by constitutions in quorum calculations, and their signed requests will be rejected until they become Active.
      - name: Active
        value: Active
        description: Member has submitted a valid ACK and is a full voting participant.
  Proposals.ProposalActions:
    type: object
    description: The actions contained in a proposal, describing the proposal's changes.
    properties:
      actions:
        type: array
        description: A list of actions to apply. Each action is considered, in order, for both proposal and execution of the proposal. All actions are validated and, if the proposal is accepted, applied atomically.
        items:
          $ref: '#/definitions/Proposals.Action'
        x-ms-identifiers: []
    required:
    - actions
  Transactions.CommittedTransaction:
    type: object
    description: Description of latest committed transaction.
    properties:
      transactionId:
        $ref: '#/definitions/transactionId'
        description: Identifier of committed transaction.
      status:
        $ref: '#/definitions/Transactions.TransactionStatus'
        description: Status of this transaction.
    required:
    - transactionId
    - status
  ServiceState.JsExecMode:
    type: string
    description: Describes the execution requirements of a specific endpoint.
    enum:
    - ReadWrite
    - ReadOnly
    - Historical
    x-ms-enum:
      name: JsExecMode
      modelAsString: true
      values:
      - name: ReadWrite
        value: ReadWrite
        description: Indicates that the endpoint does (or may) produces writes to the Key-Value store.
      - name: ReadOnly
        value: ReadOnly
        description: Indicates that the endpoint is a pure read, and will never write to the Key-Value store. Note that this includes endpoints which only access node-local state, and do not read from the Key-Value store at all.
      - name: Historical
        value: Historical
        description: Indicates that the endpoint operates over a historical write to the Key-Value store rather than the latest, current state. These endpoints are also read-only, and may not produce writes.
  safeuint:
    type: integer
    format: int64
    description: A non-negative JSON-safe integer (ie max is 2^53 - 1)
    minimum: 0
  PagedMember:
    type: object
    description: Paged collection of Member items
    properties:
      value:
        type: array
        description: The Member items on this page
        items:
          $ref: '#/definitions/ServiceState.Member'
        x-ms-identifiers: []
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  ServiceState.JsApp:
    type: object
    description: Describes the currently installed JavaScript application.
    properties:
      endpoints:
        type: object
        description: The collection of endpoints exposed by the application. Keyed by path.
        additionalProperties:
          $ref: '#/definitions/ServiceState.JsOperations'
    required:
    - endpoints
  proposalId:
    type: string
    description: Hex encoding of SHA-256 of proposed actions and merkle root of store at proposal creation. Unlike other IDs, this is generated on the service and will not be known in advance.
    pattern: ^[a-f0-9]{64}$
  Proposals.MemberVotes:
    type: object
    description: Each key is a memberId, and the corresponding value is the result of their ballot.
    additionalProperties:
      type: boolean
  Recovery.EncryptedRecoveryShare:
    type: object
    description: A share of a recovery key, granted for a specific recovery member, and encrypted with that member's share-encryption key. This is safe to share in the ledger or amongst untrusted callers, as only the intended member will be able to decrypt and access the secret content.
    properties:
      encryptedShare:
        type: string
        format: byte
        description: Base-64 encoding of a member's encrypted share.
    required:
    - encryptedShare
  Proposals.FailureInfo:
    type: object
    description: Description of why governance execution failed.
    properties:
      reason:
        type: string
        description: Error message describing reason for failure.
      trace:
        type: string
        description: Call stack showing where failure occurred, if available.
    required:
    - reason
  memberId:
    type: string
    description: Hex encoding of SHA-256 of a member certificate's fingerprint.
    pattern: ^[a-f0-9]{64}$
  ServiceState.ConstitutionResponse:
    type: object
    description: Constitution used to make governance decisions on the service. All governance changes are presented as proposals which must be validated, approved, and applied by the code in this constitution.
    properties:
      constitution:
        type: string
        description: Javascript source code of constitution.
    required:
    - constitution
parameters:
  CoseSignature.body:
    name: body
    in: body
    description: 'A raw CoseSign1 signature. See CCF docs for required headers and body schema: https://microsoft.github.io/CCF/main/use_apps/issue_commands.html#cose-schemas'
    required: true
    schema:
      type: string
      format: binary
    x-ms-parameter-location: method
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'