Atlassian · Example Payload

Atlassian Searchworkspace Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Searchworkspace Example is an example object payload from Atlassian, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "searchWorkspace",
  "method": "GET",
  "path": "/workspaces/{workspace}/search/code",
  "summary": "Atlassian Search for code in a workspace",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "response",
      "example": {
        "size": 1,
        "page": 1,
        "pagelen": 10,
        "query_substituted": false,
        "values": [
          {
            "type": "code_search_result",
            "content_match_count": 2,
            "content_matches": [
              {
                "lines": [
                  {
                    "line": 2,
                    "segments": []
                  },
                  {
                    "line": 3,
                    "segments": [
                      {
                        "text": "def "
                      },
                      {
                        "text": "foo",
                        "match": true
                      },
                      {
                        "text": "():"
                      }
                    ]
                  },
                  {
                    "line": 4,
                    "segments": [
                      {
                        "text": "    print(\"snek\")"
                      }
                    ]
                  },
                  {
                    "line": 5,
                    "segments": []
                  }
                ]
              }
            ],
            "path_matches": [
              {
                "text": "src/"
              },
              {
                "text": "foo",
                "match": true
              },
              {
                "text": ".py"
              }
            ],
            "file": {
              "path": "src/foo.py",
              "type": "commit_file",
              "links": {
                "self": {
                  "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py"
                }
              }
            }
          }
        ]
      }
    }
  ]
}